#region Copyright & License

//
// Copyright 2001-2005 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

#endregion

namespace log4net.Util {
  /// <summary>
  /// Contain the information obtained when parsing formatting modifiers 
  /// in conversion modifiers.
  /// </summary>
  /// <remarks>
  /// <para>
  /// Holds the formatting information extracted from the format string by
  /// the <see cref="PatternParser"/>. This is used by the <see cref="PatternConverter"/>
  /// objects when rendering the output.
  /// </para>
  /// </remarks>
  /// <author>Nicko Cadell</author>
  /// <author>Gert Driesen</author>
  public class FormattingInfo {
    #region Public Instance Constructors

    /// <summary>
    /// Defaut Constructor
    /// </summary>
    /// <remarks>
    /// <para>
    /// Initializes a new instance of the <see cref="FormattingInfo" /> class.
    /// </para>
    /// </remarks>
    public FormattingInfo() {}

    /// <summary>
    /// Constructor
    /// </summary>
    /// <remarks>
    /// <para>
    /// Initializes a new instance of the <see cref="FormattingInfo" /> class
    /// with the specified parameters.
    /// </para>
    /// </remarks>
    public FormattingInfo(int min, int max, bool leftAlign) {
      m_min = min;
      m_max = max;
      LeftAlign = leftAlign;
    }

    #endregion Public Instance Constructors

    #region Public Instance Properties

    /// <summary>
    /// Gets or sets the minimum value.
    /// </summary>
    /// <value>
    /// The minimum value.
    /// </value>
    /// <remarks>
    /// <para>
    /// Gets or sets the minimum value.
    /// </para>
    /// </remarks>
    public int Min {
      get { return m_min; }
      set { m_min = value; }
    }

    /// <summary>
    /// Gets or sets the maximum value.
    /// </summary>
    /// <value>
    /// The maximum value.
    /// </value>
    /// <remarks>
    /// <para>
    /// Gets or sets the maximum value.
    /// </para>
    /// </remarks>
    public int Max {
      get { return m_max; }
      set { m_max = value; }
    }

    /// <summary>
    /// Gets or sets a flag indicating whether left align is enabled
    /// or not.
    /// </summary>
    /// <value>
    /// A flag indicating whether left align is enabled or not.
    /// </value>
    /// <remarks>
    /// <para>
    /// Gets or sets a flag indicating whether left align is enabled or not.
    /// </para>
    /// </remarks>
    public bool LeftAlign { get; set; }

    #endregion Public Instance Properties

    #region Private Instance Fields

    int m_max = int.MaxValue;
    int m_min = -1;

    #endregion Private Instance Fields
  }
}